1. Dokumentationen
  2. Example Documentation

Dokumentationen

Example Documentation

Source Code

The source code of this documentation is available on GitHub:
https://github.com/id-unibe-ch/example-doc

File naming

See File naming and handling for more information about file naming conventions and handling of multilingual content.

Folder structure

See Folder naming and handling for more information about folder naming conventions and structures.

Images

See Image handling and usage for more information about image handling and usage in the documentation.

Page structure

Each documentation page must have the following structure:
File Header

Info

Unused sections may be removed, for example if you do not want to have a subtext, just remove the whole section including the ---- lines.

Main Page Uuid

Make sure to set a Uuid field on the main page of your documentation.
This is required for referencing the documentation from the static page.
Take the Example Documentation main page as reference. Subpages do not need to have a Uuid field as it will be created automatically by Kirby CMS.